You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This pull request introduces nullability annotations to improve type safety and clarify the handling of nullable values in several exception classes within the Selenium Java codebase. The changes ensure that parameters and fields that can accept or return null are explicitly marked as nullable, while the classes themselves are marked as null-safe.
Nullability Annotations Added to Exception Classes:
NoSuchSessionException:
Added @NullMarked annotation to the class.
Marked the reason parameter in constructors as @Nullable.
ScriptTimeoutException:
Added @NullMarked annotation to the class.
Marked the message and cause parameters in constructors as @Nullable.
SessionNotCreatedException:
Added @NullMarked annotation to the class.
Marked the msg and cause parameters in constructors as @Nullable.
TimeoutException:
Added @NullMarked annotation to the class.
Marked the message and cause parameters in constructors as @Nullable.
UnhandledAlertException:
Added @NullMarked annotation to the class.
Marked the alertText field and the message and alertText parameters in constructors as @Nullable.
Updated the getAlertText method to return @Nullable.
💡 Additional Considerations
🔄 Types of changes
Cleanup (formatting, renaming)
PR Type
Enhancement
Description
Added JSpecify nullability annotations to exception classes
Marked classes as @NullMarked for null safety
Annotated constructor parameters and fields as @Nullable
Enhanced type safety for exception handling
Changes diagram
flowchart LR
A["Exception Classes"] --> B["@NullMarked Annotation"]
A --> C["@Nullable Parameters"]
B --> D["Type Safety"]
C --> D
Loading
Changes walkthrough 📝
Relevant files
Enhancement
NoSuchSessionException.java
Added nullability annotations to NoSuchSessionException
The constructor logic concatenates a nullable msg parameter directly in string operations without null checks, which could result in "null" being displayed in error messages when msg is null.
publicSessionNotCreatedException(@NullableStringmsg) {
super(
"Could not start a new session. "
+ msg
+ (msg != null && msg.contains("Host info") ? "" : " \n" + getHostInformation()));
}
The constructor concatenates nullable message and alertText parameters directly without null checks, potentially resulting in "null" strings in the exception message.
The string concatenation with a nullable msg parameter can result in "null" being literally concatenated to the message. Consider using a null-safe approach to avoid displaying "null" in error messages.
public SessionNotCreatedException(@Nullable String msg) {
super(
"Could not start a new session. "
- + msg+ + (msg != null ? msg : "")
+ (msg != null && msg.contains("Host info") ? "" : " \n" + getHostInformation()));
}
Apply / Chat
Suggestion importance[1-10]: 7
__
Why: The suggestion correctly identifies that concatenating a null string msg will result in the literal "null" in the exception message, and the proposed fix prevents this, improving message quality.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User description
🔗 Related Issues
partially fixes #14291
💥 What does this PR do?
same as #16024
🔧 Implementation Notes
This pull request introduces nullability annotations to improve type safety and clarify the handling of nullable values in several exception classes within the Selenium Java codebase. The changes ensure that parameters and fields that can accept or return
nullare explicitly marked as nullable, while the classes themselves are marked as null-safe.Nullability Annotations Added to Exception Classes:
NoSuchSessionException:@NullMarkedannotation to the class.reasonparameter in constructors as@Nullable.ScriptTimeoutException:@NullMarkedannotation to the class.messageandcauseparameters in constructors as@Nullable.SessionNotCreatedException:@NullMarkedannotation to the class.msgandcauseparameters in constructors as@Nullable.TimeoutException:@NullMarkedannotation to the class.messageandcauseparameters in constructors as@Nullable.UnhandledAlertException:@NullMarkedannotation to the class.alertTextfield and themessageandalertTextparameters in constructors as@Nullable.getAlertTextmethod to return@Nullable.💡 Additional Considerations
🔄 Types of changes
PR Type
Enhancement
Description
Added JSpecify nullability annotations to exception classes
Marked classes as
@NullMarkedfor null safetyAnnotated constructor parameters and fields as
@NullableEnhanced type safety for exception handling
Changes diagram
Changes walkthrough 📝
NoSuchSessionException.java
Added nullability annotations to NoSuchSessionExceptionjava/src/org/openqa/selenium/NoSuchSessionException.java
@NullMarkedclass annotationreasonconstructor parameters as@NullableScriptTimeoutException.java
Added nullability annotations to ScriptTimeoutExceptionjava/src/org/openqa/selenium/ScriptTimeoutException.java
@NullMarkedclass annotationmessageandcauseconstructor parameters as@NullableSessionNotCreatedException.java
Added nullability annotations to SessionNotCreatedExceptionjava/src/org/openqa/selenium/SessionNotCreatedException.java
@NullMarkedclass annotationmsgandcauseconstructor parameters as@NullableTimeoutException.java
Added nullability annotations to TimeoutExceptionjava/src/org/openqa/selenium/TimeoutException.java
@NullMarkedclass annotationmessageandcauseconstructor parameters as@NullableUnhandledAlertException.java
Added nullability annotations to UnhandledAlertExceptionjava/src/org/openqa/selenium/UnhandledAlertException.java
@NullMarkedclass annotationalertTextfield and constructor parameters as@NullablegetAlertTextmethod return type as@Nullable